Inside Macintosh: QuickTime /

Chapter 2 - Movie Toolbox / Movie Toolbox Reference

Functions That Modify Movie Properties / Working With Movie Spatial Characteristics

GetMovieDisplayClipRgn

The GetMovieDisplayClipRgn function allows your application to determine a movie's current display clipping region.

pascal RgnHandle GetMovieDisplayClipRgn (Movie theMovie);

theMovie

Specifies the movie for this operation. Your application obtains this movie identifier from such functions as NewMovie, NewMovieFromFile, and NewMovieFromHandle (described on page 2-80, page 2-76, and page 2-78, respectively).

DESCRIPTION

The display clipping region defines the final clipping that is applied to the movie before it is displayed. The display clipping region is valid for the entire duration of the movie.

Note that the display clipping region is not saved with the movie.

The GetMovieDisplayClipRgn function allocates the region and returns a handle to the region. Your application must dispose of this region when you are done with it. If the function could not satisfy your request or if there is no display clipping region defined for the movie, the function sets the returned handle to nil.

ERROR CODES

invalidMovie

-2010

This movie is corrupted or invalid

Memory Manager errors

SEE ALSO

You can set the display clipping region by calling the SetMovieDisplayClipRgn function, which is described in the previous section.